Vcenter Vm Hardware Serial UpdateSpec

The Vcenter Vm Hardware Serial UpdateSpec schema describes the updates to be made to the configuration of a virtual serial port.

JSON Example

{
    "yield_on_poll": false,
    "backing": {
        "type": "string",
        "file": "string",
        "host_device": "string",
        "pipe": "string",
        "no_rx_loss": false,
        "network_location": "string",
        "proxy": "string"
    },
    "start_connected": false,
    "allow_guest_control": false
}

boolean

yield_on_poll

Optional

CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.

This property may be modified at any time, and changes applied to a connected virtual serial port take effect immediately.

If missing or null, the value is unchanged.

backing

Optional

Physical resource backing for the virtual serial port.

This property may only be modified if the virtual machine is not powered on or the virtual serial port is not connected.

If missing or null, the value is unchanged.

boolean

start_connected

Optional

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

If missing or null, the value is unchanged.

boolean

allow_guest_control

Optional

Flag indicating whether the guest can connect and disconnect the device.

If missing or null, the value is unchanged.

Parameter To

Vcenter Vm Hardware Serial update